<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfGtkChat</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfgtk-0.4 Reference Manual">
<link rel="up" href="ch01.html" title="libinfgtk API">
<link rel="prev" href="InfGtkCertificateView.html" title="InfGtkCertificateView">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfGtkCertificateView.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfgtk-0.4 Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfGtkChat.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfGtkChat.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfGtkChat.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#InfGtkChat.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#InfGtkChat.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="InfGtkChat">
<a name="InfGtkChat"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfGtkChat.top_of_page"></a>InfGtkChat</span></h2>
<p>InfGtkChat — Gtk interface to <a href="../libinfinity-0.4/InfChatSession.html"><span class="type">InfChatSession</span></a></p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="InfGtkChat.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfGtkChat.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libinfgtk/inf-gtk-chat.h&gt;

                    <a class="link" href="InfGtkChat.html#InfGtkChat-struct" title="InfGtkChat">InfGtkChat</a>;
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="InfGtkChat.html#inf-gtk-chat-new" title="inf_gtk_chat_new ()">inf_gtk_chat_new</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfGtkChat.html#inf-gtk-chat-set-session" title="inf_gtk_chat_set_session ()">inf_gtk_chat_set_session</a>            (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>,
                                                         <em class="parameter"><code><a href="../libinfinity-0.4/InfChatSession.html"><span class="type">InfChatSession</span></a> *session</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfGtkChat.html#inf-gtk-chat-set-active-user" title="inf_gtk_chat_set_active_user ()">inf_gtk_chat_set_active_user</a>        (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>,
                                                         <em class="parameter"><code><a href="../libinfinity-0.4/InfUser.html"><span class="type">InfUser</span></a> *user</code></em>);
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="InfGtkChat.html#inf-gtk-chat-get-entry" title="inf_gtk_chat_get_entry ()">inf_gtk_chat_get_entry</a>              (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfGtkChat.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
               +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a>
                     +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a>
                           +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html">GtkBox</a>
                                 +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkVBox.html">GtkVBox</a>
                                       +----InfGtkChat
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="InfGtkChat.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfGtkChat implements
 AtkImplementorIface,  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="InfGtkChat.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="InfGtkChat.html#InfGtkChat--active-user" title='The "active-user" property'>active-user</a>"              <a href="../libinfinity-0.4/InfUser.html"><span class="type">InfUser</span></a>*              : Read / Write
  "<a class="link" href="InfGtkChat.html#InfGtkChat--session" title='The "session" property'>session</a>"                  <a href="../libinfinity-0.4/InfChatSession.html"><span class="type">InfChatSession</span></a>*       : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfGtkChat.description"></a><h2>Description</h2>
<p>
<a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> is a widget showing a <a href="../libinfinity-0.4/InfChatSession.html"><span class="type">InfChatSession</span></a> conversation. Use
<a class="link" href="InfGtkChat.html#inf-gtk-chat-set-session" title="inf_gtk_chat_set_session ()"><code class="function">inf_gtk_chat_set_session()</code></a> to set the session whose conversation to show
in the widget. If you have a local user in the session you can also call
<a class="link" href="InfGtkChat.html#inf-gtk-chat-set-active-user" title="inf_gtk_chat_set_active_user ()"><code class="function">inf_gtk_chat_set_active_user()</code></a>. In this case the input text entry is made
available and messages are sent via that user.
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfGtkChat.details"></a><h2>Details</h2>
<div class="refsect2" title="InfGtkChat">
<a name="InfGtkChat-struct"></a><h3>InfGtkChat</h3>
<pre class="programlisting">typedef struct _InfGtkChat InfGtkChat;</pre>
<p>
<a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> is an opaque data type. You should only access it via the
public API functions.
</p>
</div>
<hr>
<div class="refsect2" title="inf_gtk_chat_new ()">
<a name="inf-gtk-chat-new"></a><h3>inf_gtk_chat_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         inf_gtk_chat_new                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>. To show a chat conversation set a session to
show via <a class="link" href="InfGtkChat.html#inf-gtk-chat-set-session" title="inf_gtk_chat_set_session ()"><code class="function">inf_gtk_chat_set_session()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_gtk_chat_set_session ()">
<a name="inf-gtk-chat-set-session"></a><h3>inf_gtk_chat_set_session ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_gtk_chat_set_session            (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>,
                                                         <em class="parameter"><code><a href="../libinfinity-0.4/InfChatSession.html"><span class="type">InfChatSession</span></a> *session</code></em>);</pre>
<p>
Sets the chat session to show in the chat widget. If there is a previous
session set the chat view will be cleared before showing the new session.
If the previous session had an active user set it will be unset. If
<em class="parameter"><code>session</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> this function just clears the chat view and unsets the
active user, if any.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chat</code></em> :</span></p></td>
<td>A <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>The <a href="../libinfinity-0.4/InfChatSession.html"><span class="type">InfChatSession</span></a> to set.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_gtk_chat_set_active_user ()">
<a name="inf-gtk-chat-set-active-user"></a><h3>inf_gtk_chat_set_active_user ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_gtk_chat_set_active_user        (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>,
                                                         <em class="parameter"><code><a href="../libinfinity-0.4/InfUser.html"><span class="type">InfUser</span></a> *user</code></em>);</pre>
<p>
Sets the active user for the chat. This must be a user in the chat's
session's user table and it must have the <code class="literal">INF_USER_LOCAL</code> flag set, i.e.
you need to have it joined before using <a href="../libinfinity-0.4/InfcSessionProxy.html#infc-session-proxy-join-user"><code class="function">infc_session_proxy_join_user()</code></a>
or <a href="../libinfinity-0.4/InfdSessionProxy.html#infd-session-proxy-add-user"><code class="function">infd_session_proxy_add_user()</code></a>.
</p>
<p>
If an active user is set the chat's text entry is made sensitive and the
user can type chat messages. They are sent to the session as originated by
<em class="parameter"><code>user</code></em>. If <em class="parameter"><code>user</code></em>'s status changes to <code class="literal">INF_USER_UNAVAILABLE</code> or the
<code class="literal">INF_USER_LOCAL</code> flag is removed the active user will be unset
automatically.
</p>
<p>
This cannot be called when the chat has no session set yet.
Use <a class="link" href="InfGtkChat.html#inf-gtk-chat-set-session" title="inf_gtk_chat_set_session ()"><code class="function">inf_gtk_chat_set_session()</code></a> first.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chat</code></em> :</span></p></td>
<td>A <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>A local <a href="../libinfinity-0.4/InfUser.html"><span class="type">InfUser</span></a> which joined chat's session.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_gtk_chat_get_entry ()">
<a name="inf-gtk-chat-get-entry"></a><h3>inf_gtk_chat_get_entry ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         inf_gtk_chat_get_entry              (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>);</pre>
<p>
Returns the chat's text input entry.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chat</code></em> :</span></p></td>
<td>A <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The chat's <a href="http://library.gnome.org/devel/gtk/unstable/GtkEntry.html"><span class="type">GtkEntry</span></a>. This is owned by the chat, so you don't
need to free it.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="InfGtkChat.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "active-user" property'>
<a name="InfGtkChat--active-user"></a><h3>The <code class="literal">"active-user"</code> property</h3>
<pre class="programlisting">  "active-user"              <a href="../libinfinity-0.4/InfUser.html"><span class="type">InfUser</span></a>*              : Read / Write</pre>
<p>The user outgoing messages come from.</p>
</div>
<hr>
<div class="refsect2" title='The "session" property'>
<a name="InfGtkChat--session"></a><h3>The <code class="literal">"session"</code> property</h3>
<pre class="programlisting">  "session"                  <a href="../libinfinity-0.4/InfChatSession.html"><span class="type">InfChatSession</span></a>*       : Read / Write</pre>
<p>The chat session this widget is displaying.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>